kanzi::TimelineClock Class Reference

Use TimelineClock to update a Timeline based on time. More...

#include <kanzi/core.ui/animation/timeline_clock.hpp>

Inheritance diagram for kanzi::TimelineClock:

Public Types
typedef vector< TimelinePlaybackSharedPtr >	TimelinePlaybackContainer
Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator
typedef vector< PropertyStoragePtr >	PropertyStorageContainer
typedef PropertyStorageContainer::iterator	PropertyStorageIterator
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr
typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
void	addTimelinePlayback (TimelinePlaybackSharedPtr timelinePlayback)
	Adds a Timeline playback.
size_t	getActiveTimelinePlaybackCount () const
	Returns the number of active Timeline playbacks.
chrono::microseconds	getLastTickMeasurement () const
	Gets time spent on last tick operation.
size_t	getTimelinePlaybackCount () const
	Returns the number of Timeline playbacks.
bool	hasActiveTimelinePlaybacks () const
	Returns whether there are any active Timeline playbacks present.
void	removeTimelinePlayback (const TimelinePlayback &timelinePlayback)
	Removes a Timeline playback.
void	tick (chrono::milliseconds delta)
	Ticks all playbacks in the Timeline clock.
	~TimelineClock () override
	Destructor.
Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.
void	applyObjectStyles ()
	Apply all styles for an object node.
Domain *	getDomain () const
	Returns the domain the object belongs to.
const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.
MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.
detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.
ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.
ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.
	Object (Domain *domain)
void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.
void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.
	~Object () override
Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.
virtual	~MetaObject ()
Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.
template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.
PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.
void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.
void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.
PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.
PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.
template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.
bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.
bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.
bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.
bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.
bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications.
	PropertyObject ()
void	removeKzbProperties ()
	Remove all KZB properties.
void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.
template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property.
template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type.
void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.
void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.
virtual	~PropertyObject ()

Static Public Member Functions
static TimelineClockSharedPtr	create (Domain *domain)
	Creates a Timeline clock.
Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.
Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Protected Member Functions
bool	removeTimelinePlaybackFromContainer (const TimelinePlayback &timelinePlayback, TimelinePlaybackContainer &container)
	Removes a Timeline playback from a Timeline playback container.
	TimelineClock (Domain *domain)
	Constructor.
Protected Member Functions inherited from kanzi::Object
void	initialize ()
void	onCopy (const Object &other)
Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()
	MetaObject ()
Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.
AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
	Internally adds a property value source.
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
	Internally adds a property value source.
AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.
AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.
PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.
AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.
virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.
void	onCopy (const PropertyObject &other)
void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.
void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
	Removes a property value source.
void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.
void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Static Protected Member Functions
static bool	isTimelinePlaybackActive (const TimelinePlayback &timelinePlayback)
	Checks if the given Timeline playback is active or not.

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.
Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Detailed Description

Use TimelineClock to update a Timeline based on time.

To perform a playback of a Timeline, you will have to create a TimelinePlayback object by calling the Timeline::createPlayback(). To add a playback to a TimelineClock, call TimelineClock::addTimelinePlayback() function. TimelineClock will advance the global time of TimelinePlayback object which in turn will advance the Timeline. So in other words, adding playback to a clock triggers the animation.

To add a playback to a Timeline call TimelineClock::addTimelinePlayback() function:

        // Create playback context.
        SceneGraphTimelinePlaybackContext context(*nodeToAnimate);
 
        // Create playback for timeline.
        TimelinePlaybackSharedPtr timelinePlayback = timeline->createPlayback(context);
 
        // Add playback to the clock.
        timelineClock->addTimelinePlayback(timelinePlayback);

To remove an existing playback from a Timeline call TimelineClock::removeTimelinePlayback() function:

        // Remove playback from the clock.
        timelineClock->removeTimelinePlayback(*timelinePlayback);

See also

TimelinePlayback

Timeline

Member Typedef Documentation

TimelinePlaybackContainer

typedef vector<TimelinePlaybackSharedPtr> kanzi::TimelineClock::TimelinePlaybackContainer

Constructor & Destructor Documentation

~TimelineClock()

kanzi::TimelineClock::~TimelineClock ( )

inlineoverride

Destructor.

TimelineClock()

kanzi::TimelineClock::TimelineClock ( Domain * domain )

inlineexplicitprotected

Constructor.

Parameters

domain

Domain.

Member Function Documentation

addTimelinePlayback()

void kanzi::TimelineClock::addTimelinePlayback

(

TimelinePlaybackSharedPtr

timelinePlayback

)

Adds a Timeline playback.

A newly added Timeline playback is initially added to the list of new playbacks, and later moved to the list of the existing playbacks. The new playbacks are updated with a zero time delta, and the existing playbacks are updated with full time delta during the update.

Parameters

timelinePlayback

Timeline playback to add.

removeTimelinePlayback()

void kanzi::TimelineClock::removeTimelinePlayback

(

const TimelinePlayback &

timelinePlayback

)

Removes a Timeline playback.

Parameters

timelinePlayback

Timeline playback to be removed.

tick()

void kanzi::TimelineClock::tick

(

chrono::milliseconds

delta

)

Ticks all playbacks in the Timeline clock.

A newly added Timeline playback only advances one frame per tick, it can not be ticked forward with possibly arbitrarily long delta time since last frame.

Parameters

delta

Delta time since last frame.

getLastTickMeasurement()

chrono::microseconds kanzi::TimelineClock::getLastTickMeasurement ( ) const

inline

Gets time spent on last tick operation.

getActiveTimelinePlaybackCount()

size_t kanzi::TimelineClock::getActiveTimelinePlaybackCount ( ) const

inline

Returns the number of active Timeline playbacks.

The number of active Timeline playbacks may differ from total number of Timeline playbacks as some playbacks may be inactive.

Returns

The number of active Timeline playbacks.

hasActiveTimelinePlaybacks()

bool kanzi::TimelineClock::hasActiveTimelinePlaybacks ( ) const

inline

Returns whether there are any active Timeline playbacks present.

Active playback is the playback which is not paused, and not yet completed nor stopped.

Returns

If at least one Timeline playback is active, true, otherwise false.

getTimelinePlaybackCount()

size_t kanzi::TimelineClock::getTimelinePlaybackCount

(

)

const

Returns the number of Timeline playbacks.

This is the total number of playbacks, active or otherwise. This number also includes the Timeline playbacks added to the current frame.

Returns

Number of Timeline playbacks referenced by the root Timeline clock.

create()

static TimelineClockSharedPtr kanzi::TimelineClock::create ( Domain * domain )

inlinestatic

Creates a Timeline clock.

Parameters

domain

Domain.

Returns

Pointer to the Timeline clock.

removeTimelinePlaybackFromContainer()

bool kanzi::TimelineClock::removeTimelinePlaybackFromContainer ( const TimelinePlayback & timelinePlayback, TimelinePlaybackContainer & container )

protected

Removes a Timeline playback from a Timeline playback container.

Parameters

timelinePlayback	Timeline playback to remove.
container	Container to remove from.

Returns

If a playback is found and removed, true, otherwise false.

isTimelinePlaybackActive()

static bool kanzi::TimelineClock::isTimelinePlaybackActive ( const TimelinePlayback & timelinePlayback )

inlinestaticprotected

Checks if the given Timeline playback is active or not.

Parameters

timelinePlayback

Timeline playback under the check.

Returns

If if the Timeline playback is active, true, otherwise false.

---

The documentation for this class was generated from the following file:

• kanzi/core.ui/animation/timeline_clock.hpp